﻿//-----------------------------------------------------------------------
// <copyright file="ManipulateEventArgs.cs" company="Nathan Miller">
// Copyright (c) Nathan Miller.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//-----------------------------------------------------------------------
namespace TileTool.Base.Manipulator
{
    using System;
    using TileTool.Editor.Tool.Scene;

    /// <summary>
    /// Event arguments class used in the manipulator events.
    /// </summary>
    public class ManipulateEventArgs : EventArgs
    {
        /// <summary>
        /// Constructor for the event arguments.
        /// </summary>
        /// <param name="manipulator">Manipulator that triggered the event.</param>
        /// <param name="input">Input event data that caused the event to be triggered. When used for an abort event will
        /// be null.</param>
        public ManipulateEventArgs(ManipulatorBase manipulator, SceneToolInputData input)
        {
            if (manipulator == null)
            {
                throw new ArgumentNullException("manipulator", "Manipulator must be non-null.");
            }

            this.InputData = input;
            this.Manipulator = manipulator;
        }

        /// <summary>
        /// Gets the manipulator this event was triggered for.
        /// </summary>
        public ManipulatorBase Manipulator
        {
            get;
            private set;
        }

        /// <summary>
        /// Gets the input data that triggered the event.
        /// 
        /// When used in an abort, will be null.
        /// </summary>
        public SceneToolInputData InputData
        {
            get;
            private set;
        }
    }
}
